cs-salesforce-crm-xapi

Esta sección describe los atributos y uso del servicio API cs-salesforce-crm-xapi.

💂️ Información Base

• Título de la API: cs-salesforce-crm-xapi
• Versión: 1.0.0
• URL Base: https://cs-salesforce-crm-xapi.cloudhub.com/Reemplaza {env} con:
  • dev (Desarrollo)
  • qa (Aseguramiento de Calidad)
  • prod (Producción)

🔑 Autenticación

Encabezados Requeridos

• client_id
  • Longitud: 32 - 36 caracteres
  • Ejemplo: 123e4567-e89b-12d3-a456-426614174000

📌 Este encabezado es requerido en todas las solicitudes.

📊 Encabezados Comunes

La mayoría de endpoints en esta API requieren los siguientes encabezados de solicitud estándar:

Endpoints específicos pueden requerir encabezados adicionales. Consulta la documentación detallada del endpoint para requisitos específicos.

📑 Formato de Solicitud y Respuesta

Formato de Solicitud

La API soporta los siguientes formatos de solicitud:

• application/json - Para cargas útiles JSON
• application/octet-stream - Para cargas de archivos binarios

Formato de Respuesta

La API principalmente retorna respuestas en:

• application/json - Para respuestas de datos estructurados
• application/octet-stream - Para descargas de archivos

Cada respuesta incluye códigos de estado HTTP y encabezados apropiados.

📁 Resumen de Estructura de API

Esta API está organizada en varias áreas funcionales:

1. Operaciones de Azure Storage - Almacenamiento y recuperación de archivos en Azure Storage
2. Integración Senda - Operaciones para el sistema Senda Medico
   • Gestión de casos
   • Información de consultores
   • Contratos de clientes
   • Gestión de actividades
   • Sesiones de trabajo
3. Procesamiento de Reclamos - Presentación de reclamos y reportes
4. Manejo de PQR - Gestión de Peticiones, Quejas y Reclamos
5. Gestión de Documentos - Adjuntar archivos y consulta
6. Gestión de Casos - Operaciones de casos de Salesforce
7. Operaciones Especializadas - Accidentes laborales, información de pólizas, etc.

Para información detallada sobre cada endpoint, incluyendo formatos de solicitud/respuesta y parámetros, consulta la documentación específica del endpoint.

🔐 Esquemas de Seguridad

Aplicación de Client ID

La API utiliza client_id-enforcement como el esquema de seguridad principal. Todas las solicitudes deben incluir un client_id válido en los encabezados de la solicitud.

⚠️ Códigos de Error

Todos los endpoints de la API implementan manejo común de códigos de error HTTP según se define en la especificación de la API.

📚 Ejemplos de Uso

Ejemplo: Acceso a Recursos con Autenticación

curl -X GET \
  https://cs-salesforce-crm-xapi.cloudhub.com/azure/storage \
  -H 'client_id: 123e4567-e89b-12d3-a456-426614174000' \
  -H 'x-resource-name: document.pdf'

Ejemplo: Envío de Datos JSON

curl -X POST \
  https://cs-salesforce-crm-xapi.cloudhub.com/claims \
  -H 'Content-Type: application/json' \
  -H 'client_id: 123e4567-e89b-12d3-a456-426614174000' \
  -d '{
    "claimId": "CL-12345",
    "policyNumber": "POL-67890",
    "claimDate": "2025-04-15"
  }'

Consulta la documentación específica del endpoint para ejemplos más detallados.

📞 Soporte

Para asistencia, contacta al equipo de Coordinación de Servicios de Integración y Aplicaciones.

Correo electrónico: epalma@fgs.co

📅 Información Adicional

• Documentación actualizada por última vez: Julio 2025
• Para actualizaciones adicionales, consulta el Portal de Exchange de API

Documentación actualizada en julio 2025 por epalma@fgs.co - Edna Nayibe Palma

© 2025 Fundación Grupo Social - Colmena. Archivo generado para la API cs-utilities-system-api-services